<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.7.0" />

	<title>Class Swift_ByteStream_AbstractFilterableInputStream | nort</title>

	<script type="text/javascript" src="resources/combined.js?1481722677"></script>
	<script type="text/javascript" src="elementlist.js?1094816827"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?1567499433" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-App.html">App<span></span></a>
						<ul>
				<li><a href="package-App.Saas.html">Saas</a>
						</li>
				<li><a href="package-App.saas.html">saas</a>
						</li>
				<li><a href="package-App.SaaS.html">SaaS<span></span></a>
						<ul>
				<li><a href="package-App.saas.Logic.html">Logic</a>
						</li>
				<li><a href="package-App.SaaS.SaaS.html">SaaS</a>
						</li>
				<li><a href="package-App.Saas.Tables.html">Tables</a>
						</li>
				<li><a href="package-App.Saas.Vo.html">Vo</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-aqua.html">aqua<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.Monitor.html">Monitor</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-flashservices.html">flashservices<span></span></a>
						<ul>
				<li><a href="package-flashservices.adapters.html">adapters</a>
						</li>
				<li><a href="package-flashservices.debug.html">debug</a>
						</li>
				<li><a href="package-flashservices.exception.html">exception</a>
						</li>
				<li><a href="package-flashservices.filters.html">filters</a>
						</li>
				<li><a href="package-flashservices.io.html">io</a>
						</li>
				<li><a href="package-flashservices.sql.html">sql</a>
						</li>
				<li><a href="package-flashservices.util.html">util</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.html">Mekayotl<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.core.html">core</a>
						</li>
				<li><a href="package-Mekayotl.database.html">database<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.database.dal.html">dal</a>
						</li>
				<li><a href="package-Mekayotl.database.mysql.html">mysql</a>
						</li>
				<li><a href="package-Mekayotl.database.sqlite.html">sqlite</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html">render<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html.html">html</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.renders.html">renders</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
				<li><a href="package-PHPMailer.html">PHPMailer</a>
						</li>
				<li><a href="package-Services.html">Services<span></span></a>
						<ul>
				<li><a href="package-Services.JSON.html">JSON</a>
						</li>
							</ul></li>
				<li class="active"><a href="package-Swift.html">Swift<span></span></a>
						<ul>
				<li class="active"><a href="package-Swift.ByteStream.html">ByteStream</a>
						</li>
				<li><a href="package-Swift.CharacterStream.html">CharacterStream</a>
						</li>
				<li><a href="package-Swift.Encoder.html">Encoder</a>
						</li>
				<li><a href="package-Swift.Events.html">Events</a>
						</li>
				<li><a href="package-Swift.KeyCache.html">KeyCache</a>
						</li>
				<li><a href="package-Swift.Mailer.html">Mailer</a>
						</li>
				<li><a href="package-Swift.Mime.html">Mime</a>
						</li>
				<li><a href="package-Swift.Plugins.html">Plugins</a>
						</li>
				<li><a href="package-Swift.Transport.html">Transport</a>
						</li>
							</ul></li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li class="active"><a href="class-Swift_ByteStream_AbstractFilterableInputStream.html">Swift_ByteStream_AbstractFilterableInputStream</a></li>
				<li><a href="class-Swift_ByteStream_ArrayByteStream.html">Swift_ByteStream_ArrayByteStream</a></li>
				<li><a href="class-Swift_ByteStream_FileByteStream.html">Swift_ByteStream_FileByteStream</a></li>
			</ul>

			<h3>Interfaces</h3>
			<ul>
				<li><a href="class-Swift_FileStream.html">Swift_FileStream</a></li>
				<li><a href="class-Swift_InputByteStream.html">Swift_InputByteStream</a></li>
				<li><a href="class-Swift_OutputByteStream.html">Swift_OutputByteStream</a></li>
			</ul>




		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-Swift.ByteStream.html" title="Summary of Swift\ByteStream"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class Swift_ByteStream_AbstractFilterableInputStream</h1>


	<div class="description">
	
<p>Provides the base functionality for an InputStream supporting filters.</p>

	</div>

	<dl class="tree">
		<dd style="padding-left:0px">
<b><span>Swift_ByteStream_AbstractFilterableInputStream</span></b>			
			 implements 
				<a href="class-Swift_InputByteStream.html"><span>Swift_InputByteStream</span></a>, 
			
				<a href="class-Swift_Filterable.html"><span>Swift_Filterable</span></a>
			
			
		</dd>
	</dl>


	<div>
		<h4>Direct known subclasses</h4>
			<a href="class-Swift_ByteStream_FileByteStream.html">Swift_ByteStream_FileByteStream</a>, 
			<a href="class-Swift_Transport_StreamBuffer.html">Swift_Transport_StreamBuffer</a>
	</div>






	<div class="info">
		<b>Abstract</b><br />
		
		
		<b>Package:</b> <a href="package-Swift.html">Swift</a>\<a href="package-Swift.ByteStream.html">ByteStream</a><br />

				<b>Author:</b>
				Chris Corbyn<br />
		<b>Located at</b> <a href="source-class-Swift_ByteStream_AbstractFilterableInputStream.html#11" title="Go to source code">lib/php/externals/swift/classes/Swift/ByteStream/AbstractFilterableInputStream.php</a><br />
	</div>


	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="_commit" id="__commit">

		<td class="attributes"><code>
			abstract protected 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__commit">#</a>
		<code><a href="source-class-Swift_ByteStream_AbstractFilterableInputStream.html#35" title="Go to source code">_commit</a>( <span>string <var>$bytes</var></span> )</code>

		<div class="description short">
			
<p>Commit the given bytes to the storage medium immediately.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Commit the given bytes to the storage medium immediately.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$bytes</var></dt>
					<dd><code>string</code></dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="_flush" id="__flush">

		<td class="attributes"><code>
			abstract protected 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__flush">#</a>
		<code><a href="source-class-Swift_ByteStream_AbstractFilterableInputStream.html#43" title="Go to source code">_flush</a>( )</code>

		<div class="description short">
			
<p>Flush any buffers/content with immediate effect.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Flush any buffers/content with immediate effect.</p>








		</div>
		</div></td>
	</tr>
	<tr data-order="addFilter" id="_addFilter">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_addFilter">#</a>
		<code><a href="source-class-Swift_ByteStream_AbstractFilterableInputStream.html#50" title="Go to source code">addFilter</a>( <span><code><a href="class-Swift_StreamFilter.html">Swift_StreamFilter</a></code> <var>$filter</var></span>, <span>string <var>$key</var></span> )</code>

		<div class="description short">
			
<p>Add a StreamFilter to this InputByteStream.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Add a StreamFilter to this InputByteStream.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$filter</var></dt>
					<dd><code><code><a href="class-Swift_StreamFilter.html">Swift_StreamFilter</a></code></code></dd>
					<dt><var>$key</var></dt>
					<dd><code>string</code></dd>
				</dl></div>





				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Filterable.html#_">Swift_Filterable::addFilter</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="removeFilter" id="_removeFilter">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_removeFilter">#</a>
		<code><a href="source-class-Swift_ByteStream_AbstractFilterableInputStream.html#61" title="Go to source code">removeFilter</a>( <span>string <var>$key</var></span> )</code>

		<div class="description short">
			
<p>Remove an already present StreamFilter based on its $key.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Remove an already present StreamFilter based on its $key.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$key</var></dt>
					<dd><code>string</code></dd>
				</dl></div>





				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Filterable.html#_">Swift_Filterable::removeFilter</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="write" id="_write">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_write">#</a>
		<code><a href="source-class-Swift_ByteStream_AbstractFilterableInputStream.html#71" title="Go to source code">write</a>( <span>string <var>$bytes</var></span> )</code>

		<div class="description short">
			
<p>Writes $bytes to the end of the stream.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Writes $bytes to the end of the stream.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$bytes</var></dt>
					<dd><code>string</code></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br />
				</div>

				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="class-Swift_IoException.html">Swift_IoException</a></code></code><br />
				</div>



				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_InputByteStream.html#_">Swift_InputByteStream::write</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="commit" id="_commit">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_commit">#</a>
		<code><a href="source-class-Swift_ByteStream_AbstractFilterableInputStream.html#89" title="Go to source code">commit</a>( )</code>

		<div class="description short">
			
<p>For any bytes that are currently buffered inside the stream, force them off
the buffer.</p>

		</div>

		<div class="description detailed hidden">
			
<p>For any bytes that are currently buffered inside the stream, force them off
the buffer.</p>





				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="class-Swift_IoException.html">Swift_IoException</a></code></code><br />
				</div>



				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_InputByteStream.html#_">Swift_InputByteStream::commit</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="bind" id="_bind">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_bind">#</a>
		<code><a href="source-class-Swift_ByteStream_AbstractFilterableInputStream.html#101" title="Go to source code">bind</a>( <span><code><a href="class-Swift_InputByteStream.html">Swift_InputByteStream</a></code> <var>$is</var></span> )</code>

		<div class="description short">
			
<p>Attach $is to this stream. The stream acts as an observer, receiving all data
that is written. All <code><a href="class-Swift_ByteStream_AbstractFilterableInputStream.html#_">Swift_ByteStream_AbstractFilterableInputStream::write()</a></code> and <code><a href="class-Swift_ByteStream_AbstractFilterableInputStream.html#_">Swift_ByteStream_AbstractFilterableInputStream::flushBuffers()</a></code> operations will
be mirrored.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Attach $is to this stream. The stream acts as an observer, receiving all data
that is written. All <code><a href="class-Swift_ByteStream_AbstractFilterableInputStream.html#_">Swift_ByteStream_AbstractFilterableInputStream::write()</a></code> and <code><a href="class-Swift_ByteStream_AbstractFilterableInputStream.html#_">Swift_ByteStream_AbstractFilterableInputStream::flushBuffers()</a></code> operations will
be mirrored.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$is</var></dt>
					<dd><code><code><a href="class-Swift_InputByteStream.html">Swift_InputByteStream</a></code></code></dd>
				</dl></div>





				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_InputByteStream.html#_">Swift_InputByteStream::bind</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="unbind" id="_unbind">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_unbind">#</a>
		<code><a href="source-class-Swift_ByteStream_AbstractFilterableInputStream.html#114" title="Go to source code">unbind</a>( <span><code><a href="class-Swift_InputByteStream.html">Swift_InputByteStream</a></code> <var>$is</var></span> )</code>

		<div class="description short">
			
<p>Remove an already bound stream. If $is is not bound, no errors will be
raised. If the stream currently has any buffered data it will be written to $is
before unbinding occurs.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Remove an already bound stream. If $is is not bound, no errors will be
raised. If the stream currently has any buffered data it will be written to $is
before unbinding occurs.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$is</var></dt>
					<dd><code><code><a href="class-Swift_InputByteStream.html">Swift_InputByteStream</a></code></code></dd>
				</dl></div>





				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_InputByteStream.html#_">Swift_InputByteStream::unbind</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="flushBuffers" id="_flushBuffers">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_flushBuffers">#</a>
		<code><a href="source-class-Swift_ByteStream_AbstractFilterableInputStream.html#135" title="Go to source code">flushBuffers</a>( )</code>

		<div class="description short">
			
<p>Flush the contents of the stream (empty it) and set the internal pointer to
the beginning.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Flush the contents of the stream (empty it) and set the internal pointer to
the beginning.</p>





				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="class-Swift_IoException.html">Swift_IoException</a></code></code><br />
				</div>



				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_InputByteStream.html#_">Swift_InputByteStream::flushBuffers</a></code></div>
		</div>
		</div></td>
	</tr>
	</table>










</div>

	<div id="footer">
		nort API documentation generated by <a href="http://apigen.org">ApiGen 2.7.0</a>
	</div>
</div>
</div>
</body>
</html>
